<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../print.css" type="text/css" media="print">
<meta content="ScribdService,com.digitalflipbook.webapis.scribd.ScribdService,AUTH_END_POINT,END_POINT,api_key,docs,secret,session_key,urlLoader,user,getLoginURL" name="keywords">
<title>com.digitalflipbook.webapis.scribd.ScribdService</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'ScribdService - DigitalFlipbook ActionScript 3.0 Library - as3scribdlib';
				var baseRef = '../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../index.html?com/digitalflipbook/webapis/scribd/ScribdService.html&amp;com/digitalflipbook/webapis/scribd/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;ScribdService</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#constantSummary">Constants</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class ScribdService"); titleBar_setSubNav(true,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.digitalflipbook.webapis.scribd</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class ScribdService</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">ScribdService <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../images/inherit-arrow.gif"> com.adobe.webapis.URLLoaderBase</td>
</tr>
</table>
<p></p>
  Class that provides an ActionScript 3 API to the Scribd platform.
  
  <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="http://www.scribd.com/platform/" target="mm_external">http://www.scribd.com/platform/</a>
</div>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#api_key">api_key</a> : String<div class="summaryTableDescription">
   Returns the current API key in use for accessing the Scribd service.</div>
</td><td class="summaryTableOwnerCol">ScribdService</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#docs">docs</a> : <a href="methodgroups/Docs.html">Docs</a>
<div class="summaryTableDescription">[read-only]
   Provide read-only access to the Docs method group in the Scribd API
      </div>
</td><td class="summaryTableOwnerCol">ScribdService</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#secret">secret</a> : String<div class="summaryTableDescription">
   Returns the "shared secret" of the Application associated with
   the API key for use in Authentication.</div>
</td><td class="summaryTableOwnerCol">ScribdService</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#session_key">session_key</a> : String<div class="summaryTableDescription">
   Returns the current session key of the logged in user.</div>
</td><td class="summaryTableOwnerCol">ScribdService</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#user">user</a> : <a href="methodgroups/User.html">User</a>
<div class="summaryTableDescription">[read-only]
   Provide read-only access to the User method group in the Scribd API
      </div>
</td><td class="summaryTableOwnerCol">ScribdService</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#ScribdService()">ScribdService</a>(api_key:String)</div>
<div class="summaryTableDescription"></div>
</td><td class="summaryTableOwnerCol">ScribdService</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getLoginURL()">getLoginURL</a>():String</div>
<div class="summaryTableDescription">
   Returns the URL to use for authentication so the developer
   doesn't have to build it by hand.</div>
</td><td class="summaryTableOwnerCol">ScribdService</td>
</tr>
</table>
</div>
<a name="constantSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Constants</div>
<table id="summaryTableConstant" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#AUTH_END_POINT">AUTH_END_POINT</a> : String = "http://api.scribd.com/api?"<div class="summaryTableDescription">[static]
   The endpoint where we go for authentication
   </div>
</td><td class="summaryTableOwnerCol">ScribdService</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#END_POINT">END_POINT</a> : String = "http://api.scribd.com/api?"<div class="summaryTableDescription">[static]
   The REST endpoint where we can talk with Scribd service
   </div>
</td><td class="summaryTableOwnerCol">ScribdService</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="api_key"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">api_key</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>api_key:String</code>&nbsp;&nbsp;[read-write]<p>
   Returns the current API key in use for accessing the Scribd service.
    
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get api_key():String</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set api_key(value:String):void</code>
<br>
</div>
<a name="docs"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">docs</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>docs:<a href="methodgroups/Docs.html">Docs</a></code>&nbsp;&nbsp;[read-only]<p>
   Provide read-only access to the Docs method group in the Scribd API
      </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get docs():<a href="methodgroups/Docs.html">Docs</a></code>
<br>
</div>
<a name="secret"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">secret</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>secret:String</code>&nbsp;&nbsp;[read-write]<p>
   Returns the "shared secret" of the Application associated with
   the API key for use in Authentication.
   
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get secret():String</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set secret(value:String):void</code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://www.scribd.com/platform/documentation/api?method_name=user.login" target="mm_external">http://www.scribd.com/platform/documentation/api?method_name=user.login</a>
</div>
</div>
<a name="session_key"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">session_key</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>session_key:String</code>&nbsp;&nbsp;[read-write]<p>
   Returns the current session key of the logged in user.
    
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get session_key():String</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set session_key(value:String):void</code>
<br>
</div>
<a name="urlLoader"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">urlLoader</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>urlLoader:URLLoader</code>&nbsp;&nbsp;[read-only]<p>
   Use our "internal" namespace to provide access to the URLLoader
   from this class to the helper classes in the methodgroups package.
   This keeps this method away from the public API since it is not meant
   to be used by the public.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;scribdservice_internal function get urlLoader():URLLoader</code>
<br>
</div>
<a name="user"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">user</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>user:<a href="methodgroups/User.html">User</a></code>&nbsp;&nbsp;[read-only]<p>
   Provide read-only access to the User method group in the Scribd API
      </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get user():<a href="methodgroups/User.html">User</a></code>
<br>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="ScribdService()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">ScribdService</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function ScribdService(api_key:String)</code><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">api_key</span>:String</code></td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="getLoginURL()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getLoginURL</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function getLoginURL():String</code><p>
   Returns the URL to use for authentication so the developer
   doesn't have to build it by hand.
      </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>String</code> &mdash; The url to authenticate against
   </td>
</tr>
</table>
</div>
<a name="constantDetail"></a>
<div class="detailSectionHeader">Constant detail</div>
<a name="AUTH_END_POINT"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">AUTH_END_POINT</td><td class="detailHeaderType">constant</td>
</tr>
</table>
<div class="detailBody">
<code>public static const AUTH_END_POINT:String = "http://api.scribd.com/api?"</code><p>
   The endpoint where we go for authentication
   </p></div>
<a name="END_POINT"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">END_POINT</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const END_POINT:String = "http://api.scribd.com/api?"</code><p>
   The REST endpoint where we can talk with Scribd service
   </p></div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
